﻿/**
 * @file std_deque.h
 * Copyright (c) 2019 Gaaagaa. All rights reserved.
 * 
 * @author  : Gaaagaa
 * @date    : 2019-09-09
 * @version : 1.0.0.0
 * @brief   : 使用 C API 的接口形式实现 双端队列 容器。
 */

/**
 * The MIT License (MIT)
 * Copyright (c) Gaaagaa. All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef __STD_DEQUE_H__
#define __STD_DEQUE_H__

#include "std_comm.h"

////////////////////////////////////////////////////////////////////////////////

#ifdef __cplusplus
extern "C"
{
#endif // __cplusplus

////////////////////////////////////////////////////////////////////////////////

//====================================================================

// 
// xstd_deque_t 的相关数据类型定义
// 

#define XDEQ_FALSE           XSTD_FALSE
#define XDEQ_TRUE            XSTD_TRUE
#define XDEQ_NULL            XSTD_NULL

typedef xstd_void_t          xdeq_void_t;
typedef xstd_bool_t          xdeq_bool_t;
typedef xstd_size_t          xdeq_size_t;
typedef xstd_elem_t          xdeq_elem_t;
typedef xstd_ctxt_t          xdeq_ctxt_t;

/** 声明 xstd_deque_t 对象指针类型 */
typedef struct xstd_deque_t * xdeq_this_t;

/** 声明 xstd_deque_t 对象的使用节点迭代器类型 */
typedef struct xdeq_node_t * xdeq_iter_t;

//====================================================================

// 
// xstd_deque_t 的相关操作接口
// 

/**********************************************************/
/**
 * @brief 返回内部的 sizeof(xstd_deque_t) 值。
 */
xdeq_size_t std_deque_sizeof(void);

/**********************************************************/
/**
 * @brief 创建 xstd_deque_t 对象。
 * @note  应使用 @see std_deque_destroy() 销毁所创建的对象。
 * 
 * @param [in ] xdeq_ctxt : 队列 所存储的节点元素上下文描述信息。
 * 
 * @return xdeq_this_t : 返回所创建的 xstd_deque_t 对象指针。
 */
xdeq_this_t std_deque_create(xdeq_ctxt_t xdeq_ctxt);

/**********************************************************/
/**
 * @brief 
 * 销毁 xstd_deque_t 对象，
 * 其由 @see std_deque_create() 接口所创建。
 */
xdeq_void_t std_deque_destroy(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 在指定的缓存上创建 xstd_deque_t 对象。
 * @note
 * 1. 所使用的缓存，其大小应不小于 @see std_deque_sizeof() 的返回值。
 * 2. 销毁对象时，应使用 @see std_deque_emplace_destroy() 接口。
 * 
 * @param [out] xdeq_this : 创建 xstd_deque_t 对象使用的缓存。
 * @param [in ] xdeq_ctxt : 队列 所存储的节点元素上下文描述信息。
 * 
 * @return xdeq_this_t : 返回所创建的 xstd_deque_t 对象指针。
 */
xdeq_this_t std_deque_emplace_create(
                    xdeq_this_t xdeq_this,
                    xdeq_ctxt_t xdeq_ctxt);

/**********************************************************/
/**
 * @brief 
 * 销毁 xstd_deque_t 对象，
 * 其由 @see std_deque_emplace_create() 接口所创建。
 */
xdeq_void_t std_deque_emplace_destroy(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的 上下文信息。
 */
xdeq_ctxt_t std_deque_ctxt(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的 类型标识。
 */
xdeq_size_t std_deque_etype(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象当前的节点数量。
 */
xdeq_size_t std_deque_size(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 判断 xstd_deque_t 对象是否为空。
 */
xdeq_bool_t std_deque_empty(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象可容纳最大的节点数量。
 */
xdeq_size_t std_deque_maxsize(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 
 * 调整 xstd_deque_t 对象的内部存储缓存大小，
 * 释放多余空间，以适应当前容纳的节点元素数量。
 */
xdeq_void_t std_deque_shrink(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 将 多个（相同的）节点值 指派给 xstd_deque_t 对象。
 * @note  该操作会更新整个 xstd_deque_t 对象，包括节点数量。
 * 
 * @param [in,out] xdeq_this : xstd_deque_t 对象。
 * @param [in    ] xdeq_size : 指派的节点数量。
 * @param [in    ] xdeq_elem : 指派的节点值。
 */
xdeq_void_t std_deque_assign(
                xdeq_this_t xdeq_this,
                xdeq_size_t xdeq_size,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 使用指定元素值填充 xstd_deque_t 对象指定区域的节点元素。
 * 
 * @param [in,out] xdeq_this   : xstd_deque_t 对象。
 * @param [in    ] xiter_first : 填充操作的区域起始节点位置。
 * @param [in    ] xiter_last  : 填充操作的区域结束节点位置。
 * @param [in    ] xdeq_elem   : 填充操作所使用的。
 * 
 * @return xdeq_iter_t : 返回 xiter_last 对应的节点迭代器。
 */
xdeq_iter_t std_deque_fill(
                xdeq_this_t xdeq_this,
                xdeq_iter_t xiter_first,
                xdeq_iter_t xiter_last,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 返回 xdeq_this 对象指定索引位置上的 元素。
 * 
 * @param [in ] xdeq_this : xdeq_this 对象。
 * @param [in ] xdeq_rpos : 索引位置（相对于 0 的偏移量）。
 * 
 * @return xdeq_elem_t : 所存储的元素对象。
 */
xdeq_elem_t std_deque_at(xdeq_this_t xdeq_this, xdeq_size_t xdeq_rpos);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的前端节点值。
 */
xdeq_elem_t std_deque_front(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的后端节点值。
 */
xdeq_elem_t std_deque_back(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 清除 xstd_deque_t 对象中的所有节点。
 */
xdeq_void_t std_deque_clear(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 
 * 在 xstd_deque_t 对象指定位置上插入元素。
 * @note 
 * 该操作有可能导致 xstd_deque_t 对象扩容，引起外部操作的迭代器无效。
 * 
 * @param [in,out] xdeq_this : xstd_deque_t 对象。
 * @param [in    ] xiter_pos : 插入节点的位置。
 * @param [in    ] xdeq_elem : 节点所存储的元素。
 * 
 * @return xdeq_iter_t : 插入后的节点对应的迭代器位置。
 */
xdeq_iter_t std_deque_insert(
                xdeq_this_t xdeq_this,
                xdeq_iter_t xiter_pos,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 
 * 以右值 move 操作元素拷贝的方式，
 * 在 xstd_deque_t 对象指定位置上安放新元素。
 * @note 
 * 该操作有可能导致 xstd_deque_t 对象扩容，
 * 引起外部操作的迭代器无效。
 * 
 * @param [in,out] xdeq_this : xstd_deque_t 对象。
 * @param [in    ] xiter_pos : 插入节点的位置。
 * @param [in    ] xdeq_elem : 节点所存储的元素。
 * 
 * @return xdeq_iter_t : 安放后的节点对应的迭代器位置。
 */
xdeq_iter_t std_deque_emplace(
                xdeq_this_t xdeq_this,
                xdeq_iter_t xiter_pos,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 在 xstd_deque_t 对象指定位置上插入多个同值元素。
 * @note 
 * 该操作有可能导致 xstd_deque_t 对象扩容，引起外部操作的迭代器无效。
 * 
 * @param [in,out] xdeq_this : xstd_deque_t 对象。
 * @param [in    ] xiter_pos : 插入的位置。
 * @param [in    ] xst_count : 插入的节点元素数量。
 * @param [in    ] xdeq_elem : 插入的同值元素。
 * 
 * @return xdeq_iter_t : 插入后对应的起始节点迭代器位置。
 */
xdeq_iter_t std_deque_insert_n(
                xdeq_this_t xdeq_this,
                xdeq_iter_t xiter_pos,
                xdeq_size_t xst_count,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 从 xstd_deque_t 对象中删除指定的节点。
 * 
 * @param [in,out] xdeq_this : xstd_deque_t 对象。
 * @param [in    ] xiter_pos : 删除节点的所在位置。
 * 
 * @return xdeq_iter_t : 返回 xiter_pos 的后继节点迭代器。
 */
xdeq_iter_t std_deque_erase(xdeq_this_t xdeq_this, xdeq_iter_t xiter_pos);

/**********************************************************/
/**
 * @brief 
 * 从 xstd_deque_t 对象中删除 [ xiter_first, xiter_last ) 区域上的各个元素。
 * 
 * @param [in,out] xdeq_this   : xstd_deque_t 对象。
 * @param [in    ] xiter_first : 迭代区域的起始位置。
 * @param [in    ] xiter_last  : 迭代区域的结束位置。
 * 
 * @return xdeq_iter_t : 返回 xiter_last 迭代器对应的节点。
 */
xdeq_iter_t std_deque_erase_range(
                xdeq_this_t xdeq_this,
                xdeq_iter_t xiter_first,
                xdeq_iter_t xiter_last);

/**********************************************************/
/**
 * @brief
 * 调整 xstd_deque_t 对象中的节点数量到 指定值。
 * 若 指定值 多于原有的节点数量，则使用 指定节点元素 补充多出的节点。
 * 
 * @param [in,out] xdeq_this : xstd_deque_t 对象。
 * @param [in    ] xdeq_size : 所要调整到的节点数量。
 * @param [in    ] xdeq_elem : 补充操作时使用的节点元素。
 */
xdeq_void_t std_deque_resize(
                xdeq_this_t xdeq_this,
                xdeq_size_t xdeq_size,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 向 xstd_deque_t 对象前端新增一个节点。
 */
xdeq_void_t std_deque_push_front(
                xdeq_this_t xdeq_this,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 向 xstd_deque_t 对象前端新增一个节点，元素以 右值move 方式进行存储。
 */
xdeq_void_t std_deque_push_mfront(
                xdeq_this_t xdeq_this,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 将 xstd_deque_t 对象的前端节点弹出（删除）。
 */
xdeq_void_t std_deque_pop_front(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 向 xstd_deque_t 对象后端新增一个节点。
 */
xdeq_void_t std_deque_push_back(
                xdeq_this_t xdeq_this,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 向 xstd_deque_t 对象后端新增一个节点，元素以 右值move 方式进行存储。
 */
xdeq_void_t std_deque_push_mback(
                xdeq_this_t xdeq_this,
                xdeq_elem_t xdeq_elem);

/**********************************************************/
/**
 * @brief 将 xstd_deque_t 对象的后端节点弹出（删除）。
 */
xdeq_void_t std_deque_pop_back(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象指定索引位置对应的迭代器。
 * 
 * @param [in ] xdeq_this : xstd_deque_t 对象。
 * @param [in ] xdeq_vpos : 索引位置。
 * 
 * @return xdeq_iter_t : 索引位置对应的迭代器。
 */
xdeq_iter_t std_deque_iter(xdeq_this_t xdeq_this, xdeq_size_t xdeq_vpos);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的起始节点 迭代器 位置。
 */
xdeq_iter_t std_deque_begin(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的结束节点 迭代器 位置。
 */
xdeq_iter_t std_deque_end(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 对 xstd_deque_t 对象的迭代器进行前移一个节点位置。
 */
xdeq_iter_t std_deque_next(xdeq_this_t xdeq_this, xdeq_iter_t xiter_trav);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的反向起始节点 迭代器 位置。
 */
xdeq_iter_t std_deque_rbegin(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的反向结束节点 迭代器 位置。
 */
xdeq_iter_t std_deque_rend(xdeq_this_t xdeq_this);

/**********************************************************/
/**
 * @brief 对 xstd_deque_t 对象的迭代器反向进行前移一个节点位置。
 */
xdeq_iter_t std_deque_rnext(xdeq_this_t xdeq_this, xdeq_iter_t xiter_trav);

/**********************************************************/
/**
 * @brief 返回 xstd_deque_t 对象的迭代器对应存储的元素值。
 */
xdeq_elem_t std_deque_elem(xdeq_this_t xdeq_this, xdeq_iter_t xiter_trav);

////////////////////////////////////////////////////////////////////////////////

/** 
 * @brief 
 * 为 xstd_deque_t 的基础数据类型容器，
 * 定义简化版操作接口的宏。
 */
#define XSTD_DEQUE_TYPE_FUNC(xtype, xname)          \
                                                    \
static inline xdeq_this_t                           \
    std_deque_create_##xname(void)                  \
{                                                   \
    return std_deque_create(&xstd_ctxt_##xname);    \
}                                                   \
                                                    \
static inline xtype                                 \
    std_deque_at_##xname(                           \
        xdeq_this_t xdeq_this,                      \
        xdeq_size_t xdeq_vpos)                      \
{                                                   \
    return *(xtype *)std_deque_at(                  \
                        xdeq_this,                  \
                        xdeq_vpos);                 \
}                                                   \
                                                    \
static inline xtype                                 \
    std_deque_front_##xname(                        \
        xdeq_this_t xdeq_this)                      \
{                                                   \
    return *(xtype *)std_deque_front(xdeq_this);    \
}                                                   \
                                                    \
static inline xtype                                 \
    std_deque_back_##xname(                         \
        xdeq_this_t xdeq_this)                      \
{                                                   \
    return *(xtype *)std_deque_back(xdeq_this);     \
}                                                   \
                                                    \
static inline xdeq_void_t                           \
    std_deque_assign_##xname(                       \
                xdeq_this_t xdeq_this,              \
                xdeq_size_t xdeq_size,              \
                xtype xdeq_elem)                    \
{                                                   \
    std_deque_assign(                               \
            xdeq_this,                              \
            xdeq_size,                              \
            &xdeq_elem);                            \
}                                                   \
                                                    \
static inline xdeq_iter_t                           \
    std_deque_fill_##xname(                         \
                xdeq_this_t xdeq_this,              \
                xdeq_iter_t xiter_first,            \
                xdeq_iter_t xiter_last,             \
                xtype xdeq_elem)                    \
{                                                   \
    return std_deque_fill(                          \
                xdeq_this,                          \
                xiter_first,                        \
                xiter_last,                         \
                &xdeq_elem);                        \
}                                                   \
                                                    \
static inline xdeq_iter_t                           \
    std_deque_insert_##xname(                       \
            xdeq_this_t xdeq_this,                  \
            xdeq_iter_t xiter_pos,                  \
            xtype xdeq_elem)                        \
{                                                   \
    return std_deque_insert(                        \
                xdeq_this,                          \
                xiter_pos,                          \
                &xdeq_elem);                        \
}                                                   \
                                                    \
static inline xdeq_iter_t                           \
    std_deque_insert_n_##xname(                     \
                xdeq_this_t xdeq_this,              \
                xdeq_iter_t xiter_pos,              \
                xdeq_size_t xst_count,              \
                xtype xdeq_elem)                    \
{                                                   \
    return std_deque_insert_n(                      \
                xdeq_this,                          \
                xiter_pos,                          \
                xst_count,                          \
                &xdeq_elem);                        \
}                                                   \
                                                    \
static inline xdeq_void_t                           \
    std_deque_push_front_##xname(                   \
                xdeq_this_t xdeq_this,              \
                xtype xdeq_elem)                    \
{                                                   \
    std_deque_push_front(xdeq_this, &xdeq_elem);    \
}                                                   \
                                                    \
static inline xdeq_void_t                           \
    std_deque_push_back_##xname(                    \
                xdeq_this_t xdeq_this,              \
                xtype xdeq_elem)                    \
{                                                   \
    std_deque_push_back(xdeq_this, &xdeq_elem);     \
}                                                   \
                                                    \
static inline xdeq_void_t                           \
    std_deque_pop_back_##xname(                     \
                xdeq_this_t xdeq_this)              \
{                                                   \
    std_deque_pop_back(xdeq_this);                  \
}                                                   \
                                                    \
static inline xdeq_void_t                           \
    std_deque_resize_##xname(                       \
                xdeq_this_t xdeq_this,              \
                xdeq_size_t xdeq_size,              \
                xtype xdeq_elem)                    \
{                                                   \
    std_deque_resize(                               \
        xdeq_this,                                  \
        xdeq_size,                                  \
        &xdeq_elem);                                \
}                                                   \
                                                    \
static inline xtype                                 \
    std_deque_elem_##xname(                         \
            xdeq_this_t xdeq_this,                  \
            xdeq_iter_t xiter_trav)                 \
{                                                   \
    return *(xtype *)std_deque_elem(                \
                            xdeq_this,              \
                            xiter_trav);            \
}

//====================================================================

XSTD_DEQUE_TYPE_FUNC(xstd_char_t   , char   )  // 对应 xstd_char_t    类型
XSTD_DEQUE_TYPE_FUNC(xstd_uchar_t  , uchar  )  // 对应 xstd_uchar_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_int8_t   , int8   )  // 对应 xstd_int8_t    类型
XSTD_DEQUE_TYPE_FUNC(xstd_int16_t  , int16  )  // 对应 xstd_int16_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_int32_t  , int32  )  // 对应 xstd_int32_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_int64_t  , int64  )  // 对应 xstd_int64_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_uint8_t  , uint8  )  // 对应 xstd_uint8_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_uint16_t , uint16 )  // 对应 xstd_uint16_t  类型
XSTD_DEQUE_TYPE_FUNC(xstd_uint32_t , uint32 )  // 对应 xstd_uint32_t  类型
XSTD_DEQUE_TYPE_FUNC(xstd_uint64_t , uint64 )  // 对应 xstd_uint64_t  类型
XSTD_DEQUE_TYPE_FUNC(xstd_long_t   , long   )  // 对应 xstd_long_t    类型
XSTD_DEQUE_TYPE_FUNC(xstd_llong_t  , llong  )  // 对应 xstd_llong_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_ulong_t  , ulong  )  // 对应 xstd_ulong_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_ullong_t , ullong )  // 对应 xstd_ullong_t  类型
XSTD_DEQUE_TYPE_FUNC(xstd_float_t  , float  )  // 对应 xstd_float_t   类型
XSTD_DEQUE_TYPE_FUNC(xstd_double_t , double )  // 对应 xstd_double_t  类型
XSTD_DEQUE_TYPE_FUNC(xstd_ldouble_t, ldouble)  // 对应 xstd_ldouble_t 类型
XSTD_DEQUE_TYPE_FUNC(xstd_handle_t , handle )  // 对应 xstd_handle_t  类型

////////////////////////////////////////////////////////////////////////////////

#ifdef __cplusplus
}; // extern "C"
#endif // __cplusplus

////////////////////////////////////////////////////////////////////////////////

#endif // __STD_DEQUE_H__

